Package com.cisco.pt.ipc.sim
Interface ParserView
- All Superinterfaces:
IPCObject
- All Known Implementing Classes:
ParserViewImpl
Information provided by the PKI file:
\class ParserView
\brief ParserView handles and manipulates parser views.
- Author:
- Auto-generated
-
Method Summary
Modifier and TypeMethodDescriptionbooleanaddCommand(String mode, String command, boolean bAll, ViewCommandAction action) Information provided by the PKI file:voidInformation provided by the PKI file:getIncludeCommandForMode(String mode, String command) Information provided by the PKI file:getIncludeCommandForModeAt(String mode, int index) Information provided by the PKI file:intInformation provided by the PKI file:getModeAt(int index) Information provided by the PKI file:intInformation provided by the PKI file:Information provided by the PKI file:intInformation provided by the PKI file:voidInformation provided by the PKI file:booleanisCommandAdded(String commandStr) Information provided by the PKI file:booleanremoveCommand(String mode, String command, ViewCommandAction action) Information provided by the PKI file:voidInformation provided by the PKI file:Methods inherited from interface com.cisco.pt.ipc.IPCObject
getAccessMessage, getClassName, getFactory, getObjectUUID, getPacketTracerSession
-
Method Details
-
setSecret
Information provided by the PKI file:
\brief Sets the secret. \param secretStr, the secret.- Parameters:
secretStr- Takes in a parameter of secretStr
-
getSecret
String getSecret()Information provided by the PKI file:
\brief Returns the secret. \return string, the secret.- Returns:
- String Returns a String
-
addCommand
Information provided by the PKI file:
\brief Adds the specified command to the view. \param mode, the mode to add the command to. Valid modes: user, enable, global. \param command, the command of interest. \param bAll, true to include all, false to not include all. \param action, the view command action. Actions: eViewCommandInclude = 0, eViewCommandExclude = 1, eViewCommandIncludeExclusive = 2 \return bool, true if successful, otherwise false.- Parameters:
mode- Takes in a parameter of modecommand- Takes in a parameter of commandbAll- Takes in a parameter of bAllaction- Takes in a parameter of action- Returns:
- boolean Returns a boolean
-
removeCommand
Information provided by the PKI file:
\brief Removes the specified command from the view. \param mode, the mode to remove the command from. Valid modes: user, enable, global. \param command, the command of interest. \param action, the view command action. Actions: eViewCommandInclude = 0, eViewCommandExclude = 1, eViewCommandIncludeExclusive = 2 \return bool, true if successful, otherwise false.- Parameters:
mode- Takes in a parameter of modecommand- Takes in a parameter of commandaction- Takes in a parameter of action- Returns:
- boolean Returns a boolean
-
getModeCount
int getModeCount()Information provided by the PKI file:
\brief Returns the number of modes. \return int, the number of modes.- Returns:
- int Returns a int
-
getModeAt
Information provided by the PKI file:
\brief Returns the mode at the specified index. \param index, the index of the mode of interest. \return string, mode at the specified index.- Parameters:
index- Takes in a parameter of index- Returns:
- String Returns a String
-
getIncludeCommandForModeCount
Information provided by the PKI file:
\brief Returns the number of include commands for the specified mode. \param mode, the mode of interest. Valid modes: user, enable, global. \return int, the number of include commands for the specified mode.- Parameters:
mode- Takes in a parameter of mode- Returns:
- int Returns a int
-
getIncludeCommandForModeAt
Information provided by the PKI file:
\brief Returns the include command in the specified mode at the specified index. \param mode, the mode of interest. Valid modes: user, enable, global. \param index, the index of the include command of interest. \return pair<string, bool>, the include command and a boolean value that is true if included in all, otherwise false.- Parameters:
mode- Takes in a parameter of modeindex- Takes in a parameter of index- Returns:
- Pair<String, Boolean> Returns a Pair<String, Boolean>
-
getIncludeCommandForMode
Information provided by the PKI file:
\brief Returns the include command in the specified mode with the specified command. \param mode, the mode of interest. Valid modes: user, enable, global. \param command, the command of interest. \return pair<string, bool>, the include command and a boolean value that is true if included in all, otherwise false.- Parameters:
mode- Takes in a parameter of modecommand- Takes in a parameter of command- Returns:
- Pair<String, Boolean> Returns a Pair<String, Boolean>
-
incrementUserCount
void incrementUserCount()Information provided by the PKI file:
\brief Increments the number of users. -
decrementUserCount
void decrementUserCount()Information provided by the PKI file:
\brief Decrements the number of users. -
getUserCount
int getUserCount()Information provided by the PKI file:
\brief Returns the number of users. \return int, the number of users.- Returns:
- int Returns a int
-
isCommandAdded
Information provided by the PKI file:
\brief Returns true if the specified command is already added to this view, otherwise false. \param commandStr, the command string to use. \return bool, true if the specified command is already added to this view, otherwise false.- Parameters:
commandStr- Takes in a parameter of commandStr- Returns:
- boolean Returns a boolean
-